// 版权所有2009年围棋作者。版权所有。
// 此源代码的使用受BSD样式的约束
// 可以在许可证文件中找到的许可证。

package xml

import (
	"bytes"
	"encoding"
	"errors"
	"fmt"
	"reflect"
	"strconv"
	"strings"
)

// BUG（rsc）：XML元素和数据结构之间的映射存在固有缺陷：
// XML元素是与顺序相关的匿名
// 值，而数据结构是与顺序无关的集合
// 命名值的名称。
// 有关更合适的文本表示，请参阅包json
// 数据结构。

// 解组器解析XML编码的数据并将结果存储在
// v指向的值，它必须是任意结构，
// 切片或字符串。不适合v的格式良好的数据是
// 丢弃的。
// None
// 因为解组器使用反射包，所以它只能分配
// 到导出的（大写）字段。解组使用区分大小写的
// 比较以将XML元素名称与标记值和结构匹配
// 字段名。
// None
// 解组使用以下规则将XML元素映射到结构。
// 在规则中，字段的标记是指与
// 在struct字段的标记中输入“xml”（参见上面的示例）。
// None
// *如果结构具有类型为[]字节或带标记的字符串的字段
// “，innerxml”，Unmarshal将嵌套在
// 这一领域的要素。其余规则仍然适用。
// None
// *如果结构有一个名为XMLName的字段，类型为Name，
// 解组在该字段中记录元素名称。
// None
// *如果XMLName字段具有表单的关联标记
// “name”或“namespace URL name”，XML元素必须具有
// 给定的名称（以及可选的名称空间）或其他解组
// 返回一个错误。
// None
// *如果XML元素具有名称与
// 带有包含“、attr”或“”的关联标记的结构字段名
// 结构字段标记中的显式名称，格式为“name，attr”，
// 解组在该字段中记录属性值。
// None
// *如果XML元素具有上一个未处理的属性
// 规则和结构具有一个字段，该字段具有包含
// “，any，attr”，解组将在第一个字段中记录属性值
// 这样的领域。
// None
// *如果XML元素包含字符数据，则该数据为
// 累积在第一个带有标记“chardata”的结构字段中。
// 结构字段的类型可能为[]字节或字符串。
// 如果没有这样的字段，则丢弃字符数据。
// None
// *如果XML元素包含注释，则它们将累积在
// 具有标记“comment”的第一个结构字段。结构
// 字段的类型可能为[]字节或字符串。如果没有
// 字段中，注释将被丢弃。
// None
// *如果XML元素包含名称匹配的子元素
// 格式为“a”或“a>b>c”的标记的前缀，解组
// 将深入到XML结构中，查找具有
// 并将最里面的元素映射到该结构
// 领域以“>”开头的标记相当于一个以“>”开头的标记
// 字段名后跟“>”。
// None
// *如果XML元素包含名称匹配的子元素
// 结构字段的XMLName标记，而结构字段没有
// 根据前面的规则，显式名称标记，解组映射
// 该结构字段的子元素。
// None
// *如果XML元素包含名称与
// 不带任何模式标志（“、attr”、“chardata”等）的字段，解组
// 将子元素映射到该结构字段。
// None
// *如果XML元素包含未匹配的子元素
// 并且该结构有一个带有标记“any”的字段，
// 解组将子元素映射到该结构字段。
// None
// *匿名结构字段的处理方式与它的
// 值是外部结构的一部分。
// None
// *带有标记“-”的结构字段永远不会被解组。
// None
// 如果解组器遇到实现解组器的字段类型
// 接口，Unmarshal调用其UnmarshalXML方法从
// XML元素。否则，如果该值实现
// encoding.TextUnmarshaler，Unmarshal调用该值的UnmarshalText方法。
// None
// 通过保存
// 该元素的字符数据在字符串或
// []字节。保存的[]字节从不为零。
// None
// 解组通过保存将属性值映射到字符串或[]字节
// 字符串或切片中的值。
// None
// 解组通过保存属性将属性值映射到属性，
// 在属性中包含其名称。
// None
// 解组将XML元素或属性值映射到切片
// 扩展切片的长度并映射元素或属性
// 到新创建的值。
// None
// 解组将XML元素或属性值映射到bool by
// 将其设置为由字符串表示的布尔值。空白
// 被修剪并忽略。
// None
// 解组将XML元素或属性值映射为整数或
// 通过将字段设置为
// 用十进制解释字符串值。没有支票
// 溢流空白被修剪并忽略。
// None
// 解组通过记录元素将XML元素映射到名称
// 名称
// None
// 解组通过设置指针将XML元素映射到指针
// 到新分配的值，然后将元素映射到该值。
// None
// 缺少的元素或空属性值将被解组为零值。
// 如果该字段是一个切片，则该字段将附加一个零值。否则
// 字段将设置为其零值。
func Unmarshal(data []byte, v interface{}) error {
	return NewDecoder(bytes.NewReader(data)).Decode(v)
}

// Decode的工作原理与Unmarshal类似，只是它读取解码器
// 流以查找开始元素。
func (d *Decoder) Decode(v interface{}) error {
	return d.DecodeElement(v, nil)
}

// DecodeElement的工作原理与Unmarshal类似，只是需要
// 指向要解码为v的开始XML元素的指针。
// 当客户机本身读取一些原始XML标记时，它非常有用
// 但也希望对某些元素进行解组。
func (d *Decoder) DecodeElement(v interface{}, start *StartElement) error {
	val := reflect.ValueOf(v)
	if val.Kind() != reflect.Ptr {
		return errors.New("non-pointer passed to Unmarshal")
	}
	return d.unmarshal(val.Elem(), start)
}

// 解组错误表示解组过程中的错误。
type UnmarshalError string

func (e UnmarshalError) Error() string { return string(e) }

// 解组器是由可以解组的对象实现的接口
// XML元素本身的描述。
// None
// 解组XML解码单个XML元素
// 从给定的开始元素开始。
// 如果返回错误，则对解组的外部调用将停止并
// 返回该错误。
// 解组XML必须只使用一个XML元素。
// 一种常见的实施策略是将
// 一个单独的值，其布局与预期的XML匹配
// 使用d.decode元素，然后从
// 将该值输入接收器。
// 另一种常见的策略是使用d.Token来处理
// XML对象一次一个令牌。
// 解组XML不能使用d.RawToken。
type Unmarshaler interface {
	UnmarshalXML(d *Decoder, start StartElement) error
}

// 解组器是由可以解组的对象实现的接口
// 它们自身的XML属性描述。
// None
// 解组XMLATTR对单个XML属性进行解码。
// 如果返回错误，则对解组的外部调用将停止并
// 返回该错误。
// UnmarshalXMLAttr仅用于具有
// 字段标记中的“attr”选项。
type UnmarshalerAttr interface {
	UnmarshalXMLAttr(attr Attr) error
}

// receiverType返回要在表达式（如“%s.MethodName”）中使用的接收器类型。
func receiverType(val interface{}) string {
	t := reflect.TypeOf(val)
	if t.Name() != "" {
		return t.String()
	}
	return "(" + t.String() + ")"
}

// 解组接口将单个XML元素解组到val中。
// 开始是元素的开始标记。
func (d *Decoder) unmarshalInterface(val Unmarshaler, start *StartElement) error {
	// 记录解码器必须在对应于开始的结束标记处停止。
	d.pushEOF()

	d.unmarshalDepth++
	err := val.UnmarshalXML(d, *start)
	d.unmarshalDepth--
	if err != nil {
		d.popEOF()
		return err
	}

	if !d.popEOF() {
		return fmt.Errorf("xml: %s.UnmarshalXML did not consume entire <%s> element", receiverType(val), start.Name.Local)
	}

	return nil
}

// 解组器TextInterface将单个XML元素解组到val中。
// 元素（但不是其子元素）中包含的chardata
// 传递给文本解组器。
func (d *Decoder) unmarshalTextInterface(val encoding.TextUnmarshaler) error {
	var buf []byte
	depth := 1
	for depth > 0 {
		t, err := d.Token()
		if err != nil {
			return err
		}
		switch t := t.(type) {
		case CharData:
			if depth == 1 {
				buf = append(buf, t...)
			}
		case StartElement:
			depth++
		case EndElement:
			depth--
		}
	}
	return val.UnmarshalText(buf)
}

// unmarshalatr将单个XML属性解组到val中。
func (d *Decoder) unmarshalAttr(val reflect.Value, attr Attr) error {
	if val.Kind() == reflect.Ptr {
		if val.IsNil() {
			val.Set(reflect.New(val.Type().Elem()))
		}
		val = val.Elem()
	}
	if val.CanInterface() && val.Type().Implements(unmarshalerAttrType) {
		// 这是一个带非指针接收器的解组器，
		// 所以这可能是不正确的，但我们会按要求去做。
		return val.Interface().(UnmarshalerAttr).UnmarshalXMLAttr(attr)
	}
	if val.CanAddr() {
		pv := val.Addr()
		if pv.CanInterface() && pv.Type().Implements(unmarshalerAttrType) {
			return pv.Interface().(UnmarshalerAttr).UnmarshalXMLAttr(attr)
		}
	}

	// 不是一个破坏者；尝试encoding.textumarshaler。
	if val.CanInterface() && val.Type().Implements(textUnmarshalerType) {
		// 这是一个带非指针接收器的解组器，
		// 所以这可能是不正确的，但我们会按要求去做。
		return val.Interface().(encoding.TextUnmarshaler).UnmarshalText([]byte(attr.Value))
	}
	if val.CanAddr() {
		pv := val.Addr()
		if pv.CanInterface() && pv.Type().Implements(textUnmarshalerType) {
			return pv.Interface().(encoding.TextUnmarshaler).UnmarshalText([]byte(attr.Value))
		}
	}

	if val.Type().Kind() == reflect.Slice && val.Type().Elem().Kind() != reflect.Uint8 {
		// 元素值的切片。
		// 生长切片。
		n := val.Len()
		val.Set(reflect.Append(val, reflect.Zero(val.Type().Elem())))

		// 重复将元素读入切片。
		if err := d.unmarshalAttr(val.Index(n), attr); err != nil {
			val.SetLen(n)
			return err
		}
		return nil
	}

	if val.Type() == attrType {
		val.Set(reflect.ValueOf(attr))
		return nil
	}

	return copyValue(val, []byte(attr.Value))
}

var (
	attrType            = reflect.TypeOf(Attr{})
	unmarshalerType     = reflect.TypeOf((*Unmarshaler)(nil)).Elem()
	unmarshalerAttrType = reflect.TypeOf((*UnmarshalerAttr)(nil)).Elem()
	textUnmarshalerType = reflect.TypeOf((*encoding.TextUnmarshaler)(nil)).Elem()
)

// 将单个XML元素解组到val中。
func (d *Decoder) unmarshal(val reflect.Value, start *StartElement) error {
	// 如果需要，请查找开始元素。
	if start == nil {
		for {
			tok, err := d.Token()
			if err != nil {
				return err
			}
			if t, ok := tok.(StartElement); ok {
				start = &t
				break
			}
		}
	}

	// 从接口加载值，但仅当结果为
	// 有用的可寻址的。
	if val.Kind() == reflect.Interface && !val.IsNil() {
		e := val.Elem()
		if e.Kind() == reflect.Ptr && !e.IsNil() {
			val = e
		}
	}

	if val.Kind() == reflect.Ptr {
		if val.IsNil() {
			val.Set(reflect.New(val.Type().Elem()))
		}
		val = val.Elem()
	}

	if val.CanInterface() && val.Type().Implements(unmarshalerType) {
		// 这是一个带非指针接收器的解组器，
		// 所以这可能是不正确的，但我们会按要求去做。
		return d.unmarshalInterface(val.Interface().(Unmarshaler), start)
	}

	if val.CanAddr() {
		pv := val.Addr()
		if pv.CanInterface() && pv.Type().Implements(unmarshalerType) {
			return d.unmarshalInterface(pv.Interface().(Unmarshaler), start)
		}
	}

	if val.CanInterface() && val.Type().Implements(textUnmarshalerType) {
		return d.unmarshalTextInterface(val.Interface().(encoding.TextUnmarshaler))
	}

	if val.CanAddr() {
		pv := val.Addr()
		if pv.CanInterface() && pv.Type().Implements(textUnmarshalerType) {
			return d.unmarshalTextInterface(pv.Interface().(encoding.TextUnmarshaler))
		}
	}

	var (
		data         []byte
		saveData     reflect.Value
		comment      []byte
		saveComment  reflect.Value
		saveXML      reflect.Value
		saveXMLIndex int
		saveXMLData  []byte
		saveAny      reflect.Value
		sv           reflect.Value
		tinfo        *typeInfo
		err          error
	)

	switch v := val; v.Kind() {
	default:
		return errors.New("unknown type " + v.Type().String())

	case reflect.Interface:
		// TODO:现在，只需忽略字段即可。不久
		// 未来，我们可能会选择从一开始就拆封
		// 元素，如果不是nil。
		return d.Skip()

	case reflect.Slice:
		typ := v.Type()
		if typ.Elem().Kind() == reflect.Uint8 {
			// []字节
			saveData = v
			break
		}

		// 元素值的切片。
		// 生长切片。
		n := v.Len()
		v.Set(reflect.Append(val, reflect.Zero(v.Type().Elem())))

		// 重复将元素读入切片。
		if err := d.unmarshal(v.Index(n), start); err != nil {
			v.SetLen(n)
			return err
		}
		return nil

	case reflect.Bool, reflect.Float32, reflect.Float64, reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr, reflect.String:
		saveData = v

	case reflect.Struct:
		typ := v.Type()
		if typ == nameType {
			v.Set(reflect.ValueOf(start.Name))
			break
		}

		sv = v
		tinfo, err = getTypeInfo(typ)
		if err != nil {
			return err
		}

		// 验证并分配元素名称。
		if tinfo.xmlname != nil {
			finfo := tinfo.xmlname
			if finfo.name != "" && finfo.name != start.Name.Local {
				return UnmarshalError("expected element type <" + finfo.name + "> but have <" + start.Name.Local + ">")
			}
			if finfo.xmlns != "" && finfo.xmlns != start.Name.Space {
				e := "expected element <" + finfo.name + "> in name space " + finfo.xmlns + " but have "
				if start.Name.Space == "" {
					e += "no name space"
				} else {
					e += start.Name.Space
				}
				return UnmarshalError(e)
			}
			fv := finfo.value(sv, initNilPointers)
			if _, ok := fv.Interface().(Name); ok {
				fv.Set(reflect.ValueOf(start.Name))
			}
		}

		// 分配属性。
		for _, a := range start.Attr {
			handled := false
			any := -1
			for i := range tinfo.fields {
				finfo := &tinfo.fields[i]
				switch finfo.flags & fMode {
				case fAttr:
					strv := finfo.value(sv, initNilPointers)
					if a.Name.Local == finfo.name && (finfo.xmlns == "" || finfo.xmlns == a.Name.Space) {
						if err := d.unmarshalAttr(strv, a); err != nil {
							return err
						}
						handled = true
					}

				case fAny | fAttr:
					if any == -1 {
						any = i
					}
				}
			}
			if !handled && any >= 0 {
				finfo := &tinfo.fields[any]
				strv := finfo.value(sv, initNilPointers)
				if err := d.unmarshalAttr(strv, a); err != nil {
					return err
				}
			}
		}

		// 确定是否需要保存字符数据或注释。
		for i := range tinfo.fields {
			finfo := &tinfo.fields[i]
			switch finfo.flags & fMode {
			case fCDATA, fCharData:
				if !saveData.IsValid() {
					saveData = finfo.value(sv, initNilPointers)
				}

			case fComment:
				if !saveComment.IsValid() {
					saveComment = finfo.value(sv, initNilPointers)
				}

			case fAny, fAny | fElement:
				if !saveAny.IsValid() {
					saveAny = finfo.value(sv, initNilPointers)
				}

			case fInnerXML:
				if !saveXML.IsValid() {
					saveXML = finfo.value(sv, initNilPointers)
					if d.saved == nil {
						saveXMLIndex = 0
						d.saved = new(bytes.Buffer)
					} else {
						saveXMLIndex = d.savedOffset()
					}
				}
			}
		}
	}

	// 查找结束元素。
	// 沿途处理子元素。
Loop:
	for {
		var savedOffset int
		if saveXML.IsValid() {
			savedOffset = d.savedOffset()
		}
		tok, err := d.Token()
		if err != nil {
			return err
		}
		switch t := tok.(type) {
		case StartElement:
			consumed := false
			if sv.IsValid() {
				consumed, err = d.unmarshalPath(tinfo, sv, nil, &t)
				if err != nil {
					return err
				}
				if !consumed && saveAny.IsValid() {
					consumed = true
					if err := d.unmarshal(saveAny, &t); err != nil {
						return err
					}
				}
			}
			if !consumed {
				if err := d.Skip(); err != nil {
					return err
				}
			}

		case EndElement:
			if saveXML.IsValid() {
				saveXMLData = d.saved.Bytes()[saveXMLIndex:savedOffset]
				if saveXMLIndex == 0 {
					d.saved = nil
				}
			}
			break Loop

		case CharData:
			if saveData.IsValid() {
				data = append(data, t...)
			}

		case Comment:
			if saveComment.IsValid() {
				comment = append(comment, t...)
			}
		}
	}

	if saveData.IsValid() && saveData.CanInterface() && saveData.Type().Implements(textUnmarshalerType) {
		if err := saveData.Interface().(encoding.TextUnmarshaler).UnmarshalText(data); err != nil {
			return err
		}
		saveData = reflect.Value{}
	}

	if saveData.IsValid() && saveData.CanAddr() {
		pv := saveData.Addr()
		if pv.CanInterface() && pv.Type().Implements(textUnmarshalerType) {
			if err := pv.Interface().(encoding.TextUnmarshaler).UnmarshalText(data); err != nil {
				return err
			}
			saveData = reflect.Value{}
		}
	}

	if err := copyValue(saveData, data); err != nil {
		return err
	}

	switch t := saveComment; t.Kind() {
	case reflect.String:
		t.SetString(string(comment))
	case reflect.Slice:
		t.Set(reflect.ValueOf(comment))
	}

	switch t := saveXML; t.Kind() {
	case reflect.String:
		t.SetString(string(saveXMLData))
	case reflect.Slice:
		if t.Type().Elem().Kind() == reflect.Uint8 {
			t.Set(reflect.ValueOf(saveXMLData))
		}
	}

	return nil
}

func copyValue(dst reflect.Value, src []byte) (err error) {
	dst0 := dst

	if dst.Kind() == reflect.Ptr {
		if dst.IsNil() {
			dst.Set(reflect.New(dst.Type().Elem()))
		}
		dst = dst.Elem()
	}

	// 保存积累的数据。
	switch dst.Kind() {
	case reflect.Invalid:
		// 可能是评论。
	default:
		return errors.New("cannot unmarshal into " + dst0.Type().String())
	case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
		if len(src) == 0 {
			dst.SetInt(0)
			return nil
		}
		itmp, err := strconv.ParseInt(strings.TrimSpace(string(src)), 10, dst.Type().Bits())
		if err != nil {
			return err
		}
		dst.SetInt(itmp)
	case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:
		if len(src) == 0 {
			dst.SetUint(0)
			return nil
		}
		utmp, err := strconv.ParseUint(strings.TrimSpace(string(src)), 10, dst.Type().Bits())
		if err != nil {
			return err
		}
		dst.SetUint(utmp)
	case reflect.Float32, reflect.Float64:
		if len(src) == 0 {
			dst.SetFloat(0)
			return nil
		}
		ftmp, err := strconv.ParseFloat(strings.TrimSpace(string(src)), dst.Type().Bits())
		if err != nil {
			return err
		}
		dst.SetFloat(ftmp)
	case reflect.Bool:
		if len(src) == 0 {
			dst.SetBool(false)
			return nil
		}
		value, err := strconv.ParseBool(strings.TrimSpace(string(src)))
		if err != nil {
			return err
		}
		dst.SetBool(value)
	case reflect.String:
		dst.SetString(string(src))
	case reflect.Slice:
		if len(src) == 0 {
			// 非零至标志存在
			src = []byte{}
		}
		dst.SetBytes(src)
	}
	return nil
}

// unmarshalPath沿着XML结构遍历，查找所需的
// 路径，并对其调用解组。
// 已使用的结果表明是否已使用XML元素
// 从解码器到开始匹配的结束元素，或者
// 由于sv的字段对start不感兴趣，所以仍然未触及。
func (d *Decoder) unmarshalPath(tinfo *typeInfo, sv reflect.Value, parents []string, start *StartElement) (consumed bool, err error) {
	recurse := false
Loop:
	for i := range tinfo.fields {
		finfo := &tinfo.fields[i]
		if finfo.flags&fElement == 0 || len(finfo.parents) < len(parents) || finfo.xmlns != "" && finfo.xmlns != start.Name.Space {
			continue
		}
		for j := range parents {
			if parents[j] != finfo.parents[j] {
				continue Loop
			}
		}
		if len(finfo.parents) == len(parents) && finfo.name == start.Name.Local {
			// 这是一场完美的比赛，在球场上表演。
			return true, d.unmarshal(finfo.value(sv, initNilPointers), start)
		}
		if len(finfo.parents) > len(parents) && finfo.parents[len(parents)] == start.Name.Local {
			// 它是字段的前缀。中断并递归
			// 因为一个字段路径本身是不合适的
			// 另一个字段路径的前缀。
			recurse = true

			// 我们可以重复使用相同的切片，只要我们
			// 不要试图附加到它。
			parents = finfo.parents[:len(parents)+1]
			break
		}
	}
	if !recurse {
		// 我们与这个元素无关。
		return false, nil
	}
	// 元素不是任何字段的完美匹配，而是一个字段
	// 一个或多个字段将此元素的路径作为父元素
	// 前缀递归并尝试匹配这些。
	for {
		var tok Token
		tok, err = d.Token()
		if err != nil {
			return true, err
		}
		switch t := tok.(type) {
		case StartElement:
			consumed2, err := d.unmarshalPath(tinfo, sv, parents, &t)
			if err != nil {
				return true, err
			}
			if !consumed2 {
				if err := d.Skip(); err != nil {
					return true, err
				}
			}
		case EndElement:
			return true, nil
		}
	}
}

// 跳过读取标记，直到它使用完结束元素
// 匹配已使用的最新开始元素。
// 如果遇到start元素，它就会递归，因此可以使用它
// 跳过嵌套结构。
// 如果找到与开始匹配的结束元素，则返回nil
// 要素否则，它将返回一个描述问题的错误。
func (d *Decoder) Skip() error {
	for {
		tok, err := d.Token()
		if err != nil {
			return err
		}
		switch tok.(type) {
		case StartElement:
			if err := d.Skip(); err != nil {
				return err
			}
		case EndElement:
			return nil
		}
	}
}
